Skip to content

Telemetry enhancement #1677

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
minjieqiu wants to merge 16 commits into
base: develop
Choose a base branch
from
Open

Telemetry enhancement #1677

minjieqiu wants to merge 16 commits into from
+1,270 −74

Conversation

@minjieqiu
Copy link

@minjieqiu minjieqiu commented Jan 29, 2026 •
edited
Loading

Description.

This PR implement SOK Telemetry enhancement. ERD:
https://cisco-my.sharepoint.com/:w:/p/mqiu/IQBoVUuEEY1SR4rDjbja0iPuAeN5dxFG-K-ZPpvO6RoWJp0?e=n5R1Ow

What does this PR have in it?.

Periodically collect (once per day) and send SOK telemetry which includes:

  1. SOK telemetry.
    a. SOK version.
    b. CPU/Memory settings (limit and request) of containers including standalone, searchheadcluster, indexercluster,
    clustermaster, clustermanager, licensemaster and licensemanager.
    c. LincenseInfo (Splunk license ID and license type).
  2. Other component's telemetry which are submitted to SOK by adding key/value to the new telemetry configmap splunk-operator-manager-telemetry

Key Changes.

  • Created a new configmap splunk-operator-manager-telemetry
  • Create a new controller which reconciles on the telemetry configmap
  • Renamed the telemetry app to app_tel_for_sok

Highlight the updates in specific files

Testing and Verification.

Tested on s1, c3 and m4.

How did you test these changes? What automated tests are added?.
Added telemetry verification to existing s1, c3 and m4 tests.

Related Issues

Jira tickets, GitHub issues, Support tickets...
https://splunk.atlassian.net/browse/CSPL-4371.

PR Checklist

  • [✅ ] Code changes adhere to the project's coding standards.
  • [ ✅ ] Relevant unit and integration tests are included.
  • [✅ ] Documentation has been updated accordingly.
  • [✅ ] All tests pass locally.
  • [✅ ] The PR description follows the project's guidelines.

@github-actions
Copy link
Contributor

github-actions bot commented Jan 29, 2026 •
edited
Loading

CLA Assistant Lite bot CLA Assistant Lite bot All contributors have signed the COC ✍️ ✅

@minjieqiu
Copy link
Author

minjieqiu commented Jan 29, 2026

I have read the CLA Document and I hereby sign the CLA

@minjieqiu
Copy link
Author

minjieqiu commented Jan 29, 2026

I have read the Code of Conduct and I hereby accept the Terms

@coveralls
Copy link
Collaborator

coveralls commented Jan 29, 2026 •
edited
Loading

Pull Request Test Coverage Report for Build 21809676211

Details

  • 310 of 466 (66.52%) changed or added relevant lines in 6 files are covered.
  • 398 unchanged lines in 21 files lost coverage.
  • Overall coverage decreased (-0.9%) to 85.451%
Changes Missing Coverage Covered Lines Changed/Added Lines %
pkg/splunk/client/enterprise.go 27 29 93.1%
pkg/splunk/enterprise/names.go 0 6 0.0%
internal/controller/telemetry_controller.go 22 46 47.83%
pkg/splunk/enterprise/telemetry.go 255 379 67.28%
Files with Coverage Reduction New Missed Lines %
pkg/splunk/client/minioclient.go 3 97.81%
pkg/splunk/enterprise/afwscheduler.go 3 92.51%
pkg/splunk/splkcontroller/controller.go 3 91.67%
internal/controller/clustermanager_controller.go 5 93.18%
internal/controller/licensemanager_controller.go 5 92.5%
internal/controller/licensemaster_controller.go 5 92.5%
internal/controller/monitoringconsole_controller.go 5 93.55%
internal/controller/searchheadcluster_controller.go 5 92.41%
internal/controller/standalone_controller.go 5 92.5%
internal/controller/clustermaster_controller.go 7 90.12%
Totals Coverage Status
Change from base Build 21358635731: -0.9%
Covered Lines: 11042
Relevant Lines: 12922
💛 - Coveralls

@minjieqiu minjieqiu marked this pull request as ready for review February 2, 2026 17:11
@minjieqiu minjieqiu changed the title [Draft]: Telemetry enhancement Telemetry enhancement Feb 2, 2026
rlieberman-splunk
rlieberman-splunk reviewed Feb 2, 2026
View reviewed changes
rlieberman-splunk
rlieberman-splunk reviewed Feb 2, 2026
View reviewed changes
rlieberman-splunk
rlieberman-splunk reviewed Feb 2, 2026
View reviewed changes
rlieberman-splunk
rlieberman-splunk reviewed Feb 2, 2026
View reviewed changes
kasiakoziol
kasiakoziol reviewed Feb 3, 2026
View reviewed changes
kasiakoziol
kasiakoziol reviewed Feb 3, 2026
View reviewed changes
@kasiakoziol
Copy link
Collaborator

kasiakoziol commented Feb 3, 2026

I think it might be worth to add/update docs

kasiakoziol
kasiakoziol reviewed Feb 3, 2026
View reviewed changes
kasiakoziol
kasiakoziol reviewed Feb 3, 2026
View reviewed changes
rlieberman-splunk
rlieberman-splunk reviewed Feb 4, 2026
View reviewed changes
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@kasiakoziol kasiakoziol kasiakoziol left review comments

@rlieberman-splunk rlieberman-splunk rlieberman-splunk approved these changes

@vivekr-splunk vivekr-splunk Awaiting requested review from vivekr-splunk

At least 2 approving reviews are required to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@minjieqiu @coveralls @kasiakoziol @rlieberman-splunk